Node / meshtastic / Meshtastic-Android / files / feature / firmware / src / commonMain / kotlin / org / meshtastic / feature / firmware / FirmwareRetriever.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.firmware

Tff7b72import T7ee787co.touchlab.kermit.Logger

Tff7b72import T7ee787kotlinx.serialization.ExperimentalSerializationApi

Tff7b72import T7ee787kotlinx.serialization.json.Json

Tff7b72import T7ee787org.koin.core.annotation.Single

Tff7b72import T7ee787org.meshtastic.core.database.entity.FirmwareRelease

Tff7b72import T7ee787org.meshtastic.core.model.DeviceHardware

Tff7b72private Tff7b72val Te6edf3KNOWN_ARCHS Tff7b72= Te6edf3setOfTb4b4b4(Ta5d6ff"Ta5d6ffesp32-s3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffesp32-c3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffesp32-c6Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffnrf52840Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffrp2040Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffstm32Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffesp32Ta5d6ff"Tb4b4b4)

Tff7b72private Tff7b72const Tff7b72val Te6edf3FIRMWARE_BASE_URL Tff7b72= Ta5d6ff"Ta5d6ffhttps://raw.githubusercontent.com/meshtastic/meshtastic.github.io/masterTa5d6ff"

T8b949e/** OTA partition role in .mt.json manifests — the main application firmware. */

Tff7b72private Tff7b72const Tff7b72val Te6edf3OTA_PART_NAME Tff7b72= Ta5d6ff"Ta5d6ffapp0Ta5d6ff"

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tff7b72private Tff7b72val Te6edf3manifestJson Tff7b72= Te6edf3Json Tb4b4b4{

Te6edf3ignoreUnknownKeys Tff7b72= Tff7b72true

Te6edf3exceptionsWithDebugInfo Tff7b72= Tff7b72false

Tb4b4b4}

T8b949e/** Retrieves firmware files, either by direct download or by extracting from a release asset zip. */

Tf0883e@Single

Tff7b72class T56d364FirmwareRetrieverTb4b4b4(Tff7b72private Tff7b72val Te6edf3fileHandlerTb4b4b4: Te6edf3FirmwareFileHandlerTb4b4b4) Tb4b4b4{

T8b949e/**

* Download the OTA firmware zip for a Nordic (nRF52) DFU update.

*

* @return The downloaded `-ota.zip` [FirmwareArtifact], or `null` if the file could not be resolved.

*/

Tff7b72suspend Tff7b72fun Td2a8ffretrieveOtaFirmwareTb4b4b4(

Te6edf3releaseTb4b4b4: Te6edf3FirmwareReleaseTb4b4b4,

Te6edf3hardwareTb4b4b4: Te6edf3DeviceHardwareTb4b4b4,

Te6edf3onProgressTb4b4b4: Tb4b4b4(Tffa657FloatTb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3FirmwareArtifact? Tff7b72= Te6edf3retrieveArtifactTb4b4b4(

Te6edf3release Tff7b72= Te6edf3releaseTb4b4b4,

Te6edf3hardware Tff7b72= Te6edf3hardwareTb4b4b4,

Te6edf3onProgress Tff7b72= Te6edf3onProgressTb4b4b4,

Te6edf3fileSuffix Tff7b72= Ta5d6ff"Ta5d6ff-ota.zipTa5d6ff"Tb4b4b4,

Te6edf3internalFileExtension Tff7b72= Ta5d6ff"Ta5d6ff.zipTa5d6ff"Tb4b4b4,

Tb4b4b4)

T8b949e/**

* Download the UF2 firmware binary for a USB Mass Storage update (nRF52 / RP2040).

*

* @return The downloaded `.uf2` [FirmwareArtifact], or `null` if the file could not be resolved.

*/

Tff7b72suspend Tff7b72fun Td2a8ffretrieveUsbFirmwareTb4b4b4(

Te6edf3releaseTb4b4b4: Te6edf3FirmwareReleaseTb4b4b4,

Te6edf3hardwareTb4b4b4: Te6edf3DeviceHardwareTb4b4b4,

Te6edf3onProgressTb4b4b4: Tb4b4b4(Tffa657FloatTb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3FirmwareArtifact? Tff7b72= Te6edf3retrieveArtifactTb4b4b4(

Te6edf3release Tff7b72= Te6edf3releaseTb4b4b4,

Te6edf3hardware Tff7b72= Te6edf3hardwareTb4b4b4,

Te6edf3onProgress Tff7b72= Te6edf3onProgressTb4b4b4,

Te6edf3fileSuffix Tff7b72= Ta5d6ff"Ta5d6ff.uf2Ta5d6ff"Tb4b4b4,

Te6edf3internalFileExtension Tff7b72= Ta5d6ff"Ta5d6ff.uf2Ta5d6ff"Tb4b4b4,

Tb4b4b4)

T8b949e/**

* Download the ESP32 OTA firmware binary. Tries in order:

* 1. `.mt.json` manifest resolution (2.7.17+)

* 2. Current naming convention (`firmware-<target>-<version>.bin`)

* 3. Legacy naming (`firmware-<target>-<version>-update.bin`)

* 4. Any matching `.bin` from the release zip

*

* @return The downloaded `.bin` [FirmwareArtifact], or `null` if the file could not be resolved.

*/

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffReturnCountTa5d6ff"Tb4b4b4)

Tff7b72suspend Tff7b72fun Td2a8ffretrieveEsp32FirmwareTb4b4b4(

Te6edf3releaseTb4b4b4: Te6edf3FirmwareReleaseTb4b4b4,

Te6edf3hardwareTb4b4b4: Te6edf3DeviceHardwareTb4b4b4,

Te6edf3onProgressTb4b4b4: Tb4b4b4(Tffa657FloatTb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3FirmwareArtifact? Tb4b4b4{

Tff7b72val Te6edf3version Tff7b72= Te6edf3releaseTb4b4b4.Te6edf3idTb4b4b4.Te6edf3removePrefixTb4b4b4(Ta5d6ff"Ta5d6ffvTa5d6ff"Tb4b4b4)

Tff7b72val Te6edf3target Tff7b72= Te6edf3hardwareTb4b4b4.Te6edf3platformioTargetTb4b4b4.Te6edf3ifEmpty Tb4b4b4{ Te6edf3hardwareTb4b4b4.Te6edf3hwModelSlug Tb4b4b4}

T8b949e// ── Primary: .mt.json manifest (2.7.17+) ────────────────────────────

Te6edf3resolveFromManifestTb4b4b4(Te6edf3versionTb4b4b4, Te6edf3targetTb4b4b4, Te6edf3releaseTb4b4b4, Te6edf3hardwareTb4b4b4, Te6edf3onProgressTb4b4b4)Tff7b72?.Te6edf3let Tb4b4b4{

Tff7b72return Tffa657it

Tb4b4b4}

T8b949e// ── Fallback 1: current naming (2.7.17+) ────────────────────────────

Tff7b72val Te6edf3currentFilename Tff7b72= Ta5d6ff"Ta5d6fffirmware-Tffd700$Te6edf3targetTa5d6ff-Tffd700$Te6edf3versionTa5d6ff.binTa5d6ff"

Te6edf3retrieveArtifactTb4b4b4(

Te6edf3release Tff7b72= Te6edf3releaseTb4b4b4,

Te6edf3hardware Tff7b72= Te6edf3hardwareTb4b4b4,

Te6edf3onProgress Tff7b72= Te6edf3onProgressTb4b4b4,

Te6edf3fileSuffix Tff7b72= Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4,

Te6edf3internalFileExtension Tff7b72= Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4,

Te6edf3preferredFilename Tff7b72= Te6edf3currentFilenameTb4b4b4,

Tb4b4b4)

Tff7b72?.Te6edf3let Tb4b4b4{

Tff7b72return Tffa657it

Tb4b4b4}

T8b949e// ── Fallback 2: legacy naming (pre-2.7.17) ──────────────────────────

Tff7b72val Te6edf3legacyFilename Tff7b72= Ta5d6ff"Ta5d6fffirmware-Tffd700$Te6edf3targetTa5d6ff-Tffd700$Te6edf3versionTa5d6ff-update.binTa5d6ff"

Te6edf3retrieveArtifactTb4b4b4(

Te6edf3release Tff7b72= Te6edf3releaseTb4b4b4,

Te6edf3hardware Tff7b72= Te6edf3hardwareTb4b4b4,

Te6edf3onProgress Tff7b72= Te6edf3onProgressTb4b4b4,

Te6edf3fileSuffix Tff7b72= Ta5d6ff"Ta5d6ff-update.binTa5d6ff"Tb4b4b4,

Te6edf3internalFileExtension Tff7b72= Ta5d6ff"Ta5d6ff-update.binTa5d6ff"Tb4b4b4,

Te6edf3preferredFilename Tff7b72= Te6edf3legacyFilenameTb4b4b4,

Tb4b4b4)

Tff7b72?.Te6edf3let Tb4b4b4{

Tff7b72return Tffa657it

Tb4b4b4}

T8b949e// ── Fallback 3: any matching .bin from the release zip ───────────────

Tff7b72return Te6edf3retrieveArtifactTb4b4b4(

Te6edf3release Tff7b72= Te6edf3releaseTb4b4b4,

Te6edf3hardware Tff7b72= Te6edf3hardwareTb4b4b4,

Te6edf3onProgress Tff7b72= Te6edf3onProgressTb4b4b4,

Te6edf3fileSuffix Tff7b72= Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4,

Te6edf3internalFileExtension Tff7b72= Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4,

Tb4b4b4)

Tb4b4b4}

T8b949e// ── Manifest resolution ──────────────────────────────────────────────────

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffReturnCountTa5d6ff"Tb4b4b4)

Tff7b72private Tff7b72suspend Tff7b72fun Td2a8ffresolveFromManifestTb4b4b4(

Te6edf3versionTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3targetTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3releaseTb4b4b4: Te6edf3FirmwareReleaseTb4b4b4,

Te6edf3hardwareTb4b4b4: Te6edf3DeviceHardwareTb4b4b4,

Te6edf3onProgressTb4b4b4: Tb4b4b4(Tffa657FloatTb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3FirmwareArtifact? Tb4b4b4{

Tff7b72val Te6edf3manifestUrl Tff7b72= Ta5d6ff"Tffd700$Te6edf3FIRMWARE_BASE_URLTa5d6ff/firmware-Tffd700$Te6edf3versionTa5d6ff/firmware-Tffd700$Te6edf3targetTa5d6ff-Tffd700$Te6edf3versionTa5d6ff.mt.jsonTa5d6ff"

Tff7b72val Te6edf3text Tff7b72= Te6edf3fileHandlerTb4b4b4.Te6edf3fetchTextTb4b4b4(Te6edf3manifestUrlTb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3text Tff7b72=Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3d Tb4b4b4{ Ta5d6ff"Ta5d6ffManifest not available at Tffd700$Te6edf3manifestUrlTa5d6ff — falling back to filename heuristicsTa5d6ff" Tb4b4b4}

Tff7b72return Tff7b72null

Tb4b4b4}

Tff7b72val Te6edf3manifest Tff7b72=

Tff7b72try Tb4b4b4{

Te6edf3manifestJsonTb4b4b4.Te6edf3decodeFromStringTff7b72<Te6edf3FirmwareManifestTff7b72>Tb4b4b4(Te6edf3textTb4b4b4)

Tb4b4b4} Tff7b72catch Tb4b4b4(Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffTooGenericExceptionCaughtTa5d6ff"Tb4b4b4) Te6edf3eTb4b4b4: Te6edf3ExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3eTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffFailed to parse manifest from Tffd700$Te6edf3manifestUrlTa5d6ff" Tb4b4b4}

Tff7b72return Tff7b72null

Tb4b4b4}

Tff7b72val Te6edf3otaEntry Tff7b72= Te6edf3manifestTb4b4b4.Te6edf3filesTb4b4b4.Te6edf3firstOrNull Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3partName Tff7b72=Tff7b72= Te6edf3OTA_PART_NAME Tb4b4b4}

Tff7b72if Tb4b4b4(Te6edf3otaEntry Tff7b72=Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3w Tb4b4b4{ Ta5d6ff"Ta5d6ffManifest has no 'Tffd700$Te6edf3OTA_PART_NAMETa5d6ff' entry — files: Tffd700${Te6edf3manifestTb4b4b4.Te6edf3filesTb4b4b4.Te6edf3map Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3partName Tb4b4b4}Tffd700}Ta5d6ff" Tb4b4b4}

Tff7b72return Tff7b72null

Tb4b4b4}

Te6edf3LoggerTb4b4b4.Te6edf3i Tb4b4b4{ Ta5d6ff"Ta5d6ffManifest resolved OTA firmware: Tffd700${Te6edf3otaEntryTb4b4b4.Te6edf3nameTffd700}Ta5d6ff (Tffd700${Te6edf3otaEntryTb4b4b4.Te6edf3bytesTffd700}Ta5d6ff bytes, md5=Tffd700${Te6edf3otaEntryTb4b4b4.Te6edf3md5Tffd700}Ta5d6ff)Ta5d6ff" Tb4b4b4}

Tff7b72return Te6edf3retrieveArtifactTb4b4b4(

Te6edf3release Tff7b72= Te6edf3releaseTb4b4b4,

Te6edf3hardware Tff7b72= Te6edf3hardwareTb4b4b4,

Te6edf3onProgress Tff7b72= Te6edf3onProgressTb4b4b4,

Te6edf3fileSuffix Tff7b72= Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4,

Te6edf3internalFileExtension Tff7b72= Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4,

Te6edf3preferredFilename Tff7b72= Te6edf3otaEntryTb4b4b4.Te6edf3nameTb4b4b4,

Tb4b4b4)

Tb4b4b4}

T8b949e// ── Private helpers ──────────────────────────────────────────────────────

Tff7b72private Tff7b72suspend Tff7b72fun Td2a8ffretrieveArtifactTb4b4b4(

Te6edf3releaseTb4b4b4: Te6edf3FirmwareReleaseTb4b4b4,

Te6edf3hardwareTb4b4b4: Te6edf3DeviceHardwareTb4b4b4,

Te6edf3onProgressTb4b4b4: Tb4b4b4(Tffa657FloatTb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4,

Te6edf3fileSuffixTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3internalFileExtensionTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3preferredFilenameTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3FirmwareArtifact? Tb4b4b4{

Tff7b72val Te6edf3version Tff7b72= Te6edf3releaseTb4b4b4.Te6edf3idTb4b4b4.Te6edf3removePrefixTb4b4b4(Ta5d6ff"Ta5d6ffvTa5d6ff"Tb4b4b4)

Tff7b72val Te6edf3target Tff7b72= Te6edf3hardwareTb4b4b4.Te6edf3platformioTargetTb4b4b4.Te6edf3ifEmpty Tb4b4b4{ Te6edf3hardwareTb4b4b4.Te6edf3hwModelSlug Tb4b4b4}

Tff7b72val Te6edf3filename Tff7b72= Te6edf3preferredFilename Tff7b72?: Ta5d6ff"Ta5d6fffirmware-Tffd700$Te6edf3targetTa5d6ff-Tffd700$Te6edf3versionTffd700$Te6edf3fileSuffixTa5d6ff"

Tff7b72val Te6edf3directUrl Tff7b72= Ta5d6ff"Tffd700$Te6edf3FIRMWARE_BASE_URLTa5d6ff/firmware-Tffd700$Te6edf3versionTa5d6ff/Tffd700$Te6edf3filenameTa5d6ff"

Tff7b72if Tb4b4b4(Te6edf3fileHandlerTb4b4b4.Te6edf3checkUrlExistsTb4b4b4(Te6edf3directUrlTb4b4b4)Tb4b4b4) Tb4b4b4{

Tff7b72try Tb4b4b4{

Te6edf3fileHandlerTb4b4b4.Te6edf3downloadFileTb4b4b4(Te6edf3directUrlTb4b4b4, Te6edf3filenameTb4b4b4, Te6edf3onProgressTb4b4b4)Tff7b72?.Te6edf3let Tb4b4b4{

Tff7b72return Tffa657it

Tb4b4b4}

Tb4b4b4} Tff7b72catch Tb4b4b4(Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffTooGenericExceptionCaughtTa5d6ff"Tb4b4b4) Te6edf3eTb4b4b4: Te6edf3ExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3eTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffDirect download for Tffd700$Te6edf3filenameTa5d6ff failed, falling back to release zipTa5d6ff" Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

Tff7b72val Te6edf3zipUrl Tff7b72= Te6edf3resolveZipUrlTb4b4b4(Te6edf3releaseTb4b4b4.Te6edf3zipUrlTb4b4b4, Te6edf3hardwareTb4b4b4.Te6edf3architectureTb4b4b4)

Tff7b72val Te6edf3downloadedZip Tff7b72= Te6edf3fileHandlerTb4b4b4.Te6edf3downloadFileTb4b4b4(Te6edf3zipUrlTb4b4b4, Ta5d6ff"Ta5d6fffirmware_release.zipTa5d6ff"Tb4b4b4, Te6edf3onProgressTb4b4b4)

Tff7b72return Te6edf3downloadedZipTff7b72?.Te6edf3let Tb4b4b4{

Te6edf3fileHandlerTb4b4b4.Te6edf3extractFirmwareFromZipTb4b4b4(Tffa657itTb4b4b4, Te6edf3hardwareTb4b4b4, Te6edf3internalFileExtensionTb4b4b4, Te6edf3preferredFilenameTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffresolveZipUrlTb4b4b4(Te6edf3urlTb4b4b4: Tffa657StringTb4b4b4, Te6edf3targetArchTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

Tff7b72for Tb4b4b4(Te6edf3arch Tff7b72in Te6edf3KNOWN_ARCHSTb4b4b4) Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3urlTb4b4b4.Te6edf3containsTb4b4b4(Te6edf3archTb4b4b4, Te6edf3ignoreCase Tff7b72= Tff7b72trueTb4b4b4)Tb4b4b4) Tb4b4b4{

Tff7b72return Te6edf3urlTb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3archTb4b4b4, Te6edf3targetArchTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4)Tb4b4b4, Te6edf3ignoreCase Tff7b72= Tff7b72trueTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tff7b72return Te6edf3url

Tb4b4b4}

Tb4b4b4}